# 83. Django - ajax、csrf中间件补充
# CSRF中间件补充
CSRF中间件用于跨站校验，如果开启就会不允许跨站传输数据，所以在这里补充二个django自带的装饰器
from django.views.decorators.csrf import csrf_exempt, csrf_protect
@csrf_exempt #给单个视图函数加上，那这个函数的跨站传输就不用校验，排除校验
@csrf_protect #给单个视图函数加上，无论CSRF中间件是否有开启，都会强制这个函数进行跨站校验，必须校验
# AJAX准备知识：JSON
# 什么是 JSON ？
- JSON 指的是 JavaScript 对象表示法（JavaScript Object Notation）
- JSON 是轻量级的文本数据交换格式
- JSON 独立于语言
- JSON 具有自我描述性，更易理解
JSON 使用 JavaScript 语法来描述数据对象，但是 JSON 仍然独立于语言和平台。JSON 解析器和 JSON 库支持许多不同的编程语言。
啥都别多说了，上图吧！
# 合格的json对象：
["one", "two", "three"]
{ "one": 1, "two": 2, "three": 3 }
{"names": ["张三", "李四"] }
[ { "name": "张三"}, {"name": "李四"} ]
# 不合格的json对象：
{ name: "张三", 'age': 32 } // 属性名必须使用双引号
[32, 64, 128, 0xFFF] // 不能使用十六进制值
{ "name": "张三", "age": undefined } // 不能使用undefined
{ "name": "张三",
"birthday": new Date('Fri, 26 Aug 2011 07:13:10 GMT'),
"getName": function() {return this.name;} // 不能使用函数和日期对象
}
# stringify与parse方法
JavaScript中关于JSON对象和字符串转换的两个方法：
JSON.parse(): 用于将一个 JSON 字符串转换为 JavaScript 对象
JSON.parse('{"name":"Q1mi"}');
JSON.parse('{name:"Q1mi"}') ; // 错误
JSON.parse('[18,undefined]') ; // 错误
JSON.stringify(): 用于将 JavaScript 值转换为 JSON 字符串。
JSON.stringify({"name":"Q1mi"})
# JSON和XML的比较
JSON 格式于2001年由 Douglas Crockford 提出，目的就是取代繁琐笨重的 XML 格式。
JSON 格式有两个显著的优点：书写简单，一目了然；符合 JavaScript 原生语法，可以由解释引擎直接处理，不用另外添加解析代码。所以，JSON迅速被接受，已经成为各大网站交换数据的标准格式，并被写入ECMAScript 5，成为标准的一部分。
XML和JSON都使用结构化方法来标记数据
# XML和JSON的对比
用XML表示中国部分省市数据如下：
<?xml version="1.0" encoding="utf-8"?>
<country>
<name>中国</name>
<province>
<name>黑龙江</name>
<cities>
<city>哈尔滨</city>
<city>大庆</city>
</cities>
</province>
<province>
<name>广东</name>
<cities>
<city>广州</city>
<city>深圳</city>
<city>珠海</city>
</cities>
</province>
<province>
<name>台湾</name>
<cities>
<city>台北</city>
<city>高雄</city>
</cities>
</province>
<province>
<name>新疆</name>
<cities>
<city>乌鲁木齐</city>
</cities>
</province>
</country>
用JSON表示中国部分省市数据如下：
{
"name": "中国",
"province": [{
"name": "黑龙江",
"cities": {
"city": ["哈尔滨", "大庆"]
}
}, {
"name": "广东",
"cities": {
"city": ["广州", "深圳", "珠海"]
}
}, {
"name": "台湾",
"cities": {
"city": ["台北", "高雄"]
}
}, {
"name": "新疆",
"cities": {
"city": ["乌鲁木齐"]
}
}]
}
由上面的两端代码可以看出，JSON 简单的语法格式和清晰的层次结构明显要比 XML 容易阅读，并且在数据交换方面，由于 JSON 所使用的字符要比 XML 少得多，可以大大得节约传输数据所占用得带宽。
# py中的json跟js中的json使用对比
python的json使用，建议去大章节2中的序列化模块文章中参考
js的json使用，建议去大章节4中的js基础中参考
# python中json数据的转换
支持的数据类型：字符串 数字 布尔值 列表 字典 None
# 序列化 python的数据类型 ——》 json字符串
json.dumps(python的数据类型)
json.dump(python的数据类型,f)
# 反序列化 json字符串 ——》 python的数据类型
json.loads(json字符串)
json.load(json字符串,f)
# js中json数据的转换
数据类型：字符串 数字 布尔值 数组 对象 null
<!-- 序列化 js的数据类型 ——》 json字符串 -->
JSON.stringify(js的数据类型)
<!-- 反序列化 json字符串 ——》 JS的数据类型 -->
JSON.parse(json字符串)
# AJAX简介
AJAX（Asynchronous Javascript And XML）翻译成中文就是 “异步的Javascript和XML”
即使用Javascript语言与服务器进行异步交互，传输的数据为XML（当然，传输的数据不只是XML）。
AJAX 不是新的编程语言，而是一种使用现有标准的新方法。
AJAX 最大的优点是在不重新加载整个页面的情况下，可以与服务器交换数据并更新部分网页内容。（这一特点给用户的感受是在不知不觉中完成请求和响应过程）
AJAX 不需要任何浏览器插件，但需要用户允许JavaScript在浏览器上执行。
- 同步交互：客户端发出一个请求后，需要等待服务器响应结束后，才能发出第二个请求；
- 异步交互：客户端发出一个请求后，无需等待服务器响应结束，就可以发出第二个请求。
# 简单示例
页面输入两个整数，通过AJAX传输到后端计算出结果并返回。
# HTML部分代码
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="x-ua-compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>AJAX局部刷新实例</title>
</head>
<body>
<input type="text" id="i1">+
<input type="text" id="i2">=
<input type="text" id="i3">
<input type="button" value="AJAX提交" id="b1">
<script src="/static/jquery-3.2.1.min.js"></script>
<script>
$("#b1").on("click", function () {
$.ajax({
url:"/ajax_add/", <!-- url地址 -->
type:"GET", <!-- 请求发送数据类型方式 -->
data:{ <!-- 要发送的数据，已字典的方式 -->
"i1":$("#i1").val(),
"i2":$("#i2").val()
},
success:function (res) { <!-- 回调函数，后台逻辑执行成功时调用，res=后台返回的内容 -->
$("#i3").val(res);
},
error: function (res) { <!-- 回调函数，后台逻辑执行失败时调用，res=后台逻辑失败的原因 -->
console.log('这是错误的')
console.log(res)
}
})
})
</script>
</body>
</html>
# views.py
def ajax_demo1(request):
return render(request, "ajax_demo1.html")
def ajax_add(request):
i1 = int(request.GET.get("i1"))
i2 = int(request.GET.get("i2"))
ret = i1 + i2
return JsonResponse(ret, safe=False)
# urls.py
urlpatterns = [
...
url(r'^ajax_add/', views.ajax_add),
url(r'^ajax_demo1/', views.ajax_demo1),
...
]
# AJAX 常见应用情景
搜索引擎根据用户输入的关键字，自动提示检索关键字。
还有一个很重要的应用场景就是注册时候的用户名的查重。
其实这里就使用了AJAX技术！当文件框发生了输入变化时，使用AJAX技术向服务器发送一个请求，然后服务器会把查询到的结果响应给浏览器，最后再把后端返回的结果展示出来。
- 整个过程中页面没有刷新，只是刷新页面中的局部位置而已！
- 当请求发出后，浏览器还可以进行其他操作，无需等待服务器的响应！
当输入登录用户名后，把光标移动到其他表单项上时，浏览器会使用AJAX技术向服务器发出请求，服务器会查询用户是否存在，最终服务器返回true表示名为用户已经存在了，浏览器在得到结果后显示“用户名已被使用”。
- 整个过程中页面没有刷新，只是局部刷新了
- 在请求发出后，浏览器不用等待服务器响应结果就可以进行其他操作
# AJAX的优点
- AJAX使用JavaScript技术向服务器发送异步请求；
- AJAX请求无须刷新整个页面；
- 因为服务器响应内容不再是整个页面，而是页面中的部分内容，所以AJAX性能高；
# jQuery实现的AJAX
最基本的jQuery发送AJAX请求示例：
# HTML文件
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta http-equiv="x-ua-compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>ajax test</title>
<script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.min.js"></script>
</head>
<body>
<button id="ajaxTest">AJAX 测试</button>
<script>
$("#ajaxTest").click(function () {
$.ajax({
url: "/ajax_test/",
type: "POST",
data: {username: "Q1mi", password: 123456},
success: function (data) {
alert(data)
}
})
})
</script>
</body>
</html>
# views.py：
def ajax_test(request):
user_name = request.POST.get("username")
password = request.POST.get("password")
print(user_name, password)
return HttpResponse("OK")
# js - $.ajax参数
data参数中的键值对，如果值值不为字符串，需要将其转换成字符串类型。
$("#b1").on("click", function () {
$.ajax({
url:"/ajax_add/",
type:"GET",
data:{"i1":$("#i1").val(),"i2":$("#i2").val(),"hehe": JSON.stringify([1, 2, 3])},
success:function (data) {
$("#i3").val(data);
}
})
})
# JS实现AJAX
var b2 = document.getElementById("b2");
b2.onclick = function () {
// 原生JS
var xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "/ajax_test/", true);
xmlHttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
xmlHttp.send("username=q1mi&password=123456");
xmlHttp.onreadystatechange = function () {
if (xmlHttp.readyState === 4 && xmlHttp.status === 200) {
alert(xmlHttp.responseText);
}
};
};
# AJAX请求如何设置csrf_token
# 方式1 - 在ajax中返回的值带上csrf_token
通过获取隐藏的input标签中的csrfmiddlewaretoken值，放置在data中发送。
依赖：要在当前文件中要有{% csrf_token %}，这配置，js才能获取到csrfmiddlewaretoken值
$.ajax({
url: "/cookie_ajax/",
type: "POST",
data: {
csrfmiddlewaretoken: $('[name="csrfmiddlewaretoken"]').val(),
name: 'msg',
age: '73',
},
success: function (res) {
console.log(res);
}
})
# 方式2 - 在ajax的请求头中带上csrf_token
通过获取返回的cookie中的字符串 放置在请求头中发送。
依赖：要在当前文件中要有{% csrf_token %}，这配置，js才能获取到csrfmiddlewaretoken值
$.ajax({
url: "/cookie_ajax/",
type: "POST",
headers: {"X-CSRFToken": $.cookie('csrftoken')}, // 从Cookie取csrftoken，并设置到请求头中
data: {
csrfmiddlewaretoken: $('[name="csrfmiddlewaretoken"]').val(),
name: 'msg',
age: '73',
},
success: function (data) {
console.log(data);
}
})
# 方式3 - 自己写个js文件，需要时导入(官方推荐)
写一个js文件，包含以下的代码，当html中需要使用ajax跟后端交互的，就可以导入这个文件，就不用使用以上二种方式，这也是官方推荐的使用方式
依赖：要在当前文件中要有{% csrf_token %}，这配置，js才能获取到csrfmiddlewaretoken值
function getCookie(name) {
var cookieValue = null;
if (document.cookie && document.cookie !== '') {
var cookies = document.cookie.split(';');
for (var i = 0; i < cookies.length; i++) {
var cookie = jQuery.trim(cookies[i]);
// Does this cookie string begin with the name we want?
if (cookie.substring(0, name.length + 1) === (name + '=')) {
cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
break;
}
}
}
return cookieValue;
}
var csrftoken = getCookie('csrftoken');
function csrfSafeMethod(method) {
// these HTTP methods do not require CSRF protection
return (/^(GET|HEAD|OPTIONS|TRACE)$/.test(method));
}
$.ajaxSetup({
beforeSend: function (xhr, settings) {
if (!csrfSafeMethod(settings.type) && !this.crossDomain) {
xhr.setRequestHeader("X-CSRFToken", csrftoken);
}
}
});
# 设置以上方式不用依赖cookie中的csrftoken
如果使用从cookie中取csrftoken的方式，需要确保cookie存在csrftoken值。
如果你的视图渲染的HTML文件中没有包含 {% csrf_token %}，Django可能不会设置CSRFtoken的cookie。
这个时候需要使用ensure_csrf_cookie()装饰器强制设置Cookie。
from django.views.decorators.csrf import ensure_csrf_cookie
@ensure_csrf_cookie ## 这样子，返回的函数会让当前页面强制加上csrftoken值的cookie
def login(request):
return redirect('/author/')
更多细节详见：Djagno官方文档中关于CSRF的内容 (opens new window)
# ajax上传文件示例
# 前端文件
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta http-equiv="content-Type" charset="UTF-8">
<meta http-equiv="x-ua-compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- 描述网页，与之对应的属性值为content
<meta name="keywords" content="">
<meta name="description" content=""> -->
<title>上传</title>
</head>
<body>
<input type="file" id="file_d1" name="file">
<button id="d1">上传</button>
<script src="/static/jquery-3.4.1.min.js"></script>
<script>
$("#d1").click(function () {
var form_obj = new FormData(); {# 创建一个类字典对象，适合用于ajax方式交互使用 #}
form_obj.append("file",$('#file_d1')[0].files[0]); {# 添加值，key：file ，value：上传文件的数据 #}
$.ajax({
url:'/upload/', {# 交互的地址 #}
type:'post', {# 交互的方式 #}
data:form_obj, {# 要传递的数据 #}
processData: false, {# 告诉jQuery不要去处理发送的数据 #}
contentType: false, {# 告诉jQuery不要去设置Content-Type请求头 #}
success:function (res) { {# 回调函数，后台逻辑执行成功时调用，res=后台返回的内容 #}
console.log(res); {# 打后端返回的消息 #}
}
})
})
</script>
</body>
</html>
# 后端文件
def upload(request):
if request.is_ajax(): ## 判断请求是不是ajax请求，如果是以下代码
file = request.FILES.get("file") ## 获取到上传文件的信息
with open(file.name, 'wb') as f: ## 打开生成一个文件，file.name为上传文件数据中自带的原生文件名
for i in file.chunks(): ## 使用for循环，慢慢的读取文件的数据
f.write(i) ## 写入
return HttpResponse("OK") ## 返回上传OK
return render(request, "upload.html") ## 如果请求不是ajax，就返回页面
# ajax用户名是否已被注册示例
功能介绍
在注册表单中，当用户填写了用户名后，把光标移开后，会自动向服务器发送异步请求。服务器返回这个用户名是否已经被注册过。
案例分析
- 页面中给出注册表单；
- 在username input标签中绑定onblur事件处理函数。
- 当input标签失去焦点后获取 username表单字段的值，向服务端发送AJAX请求；
- django的视图函数中处理该请求，获取username值，判断该用户在数据库中是否被注册，如果被注册了就返回“该用户已被注册”，否则响应“该用户名可以注册”。
# 前端文件
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta http-equiv="content-Type" charset="UTF-8">
<meta http-equiv="x-ua-compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Title</title>
</head>
<body>
<input type="text" id="name"><span style="color: red"></span>
{#<button id="b1">提交</button>#}
<script src="/static/jquery-3.4.1.min.js"></script>
<script>
$('#name').blur(function () { {# 用户框失去焦点触发 #}
$.ajax({
url: '/check/', {# 交互的地址 #}
type: 'post', {# 交互的方式 #}
data: { {# 要传递的数据 #}
xxx: $('#name').val()
},
success: (res) => { {# 回调函数，后台逻辑执行成功时调用，res=后台返回的内容 #}
console.log(res)
$(this).next().text(res) {# 找上用户框旁边的span标签，让span显示后台返回的数据 #}
}
})
}).focus(function () { {# 点击用户框触发 #}
$(this).next().text('') {# 让用户框旁边的span标签不显示 #}
})
</script>
</body>
</html>
# 后端文件
def reg(request): ## 注册页面访问跳转函数
return render(request, 'reg.html') ## 返回注册页
def check(request): ## 注册页面的ajax交互函数
name = request.POST.get('xxx') ## 获取ajax传递过来的数据
obj = models.User.objects.filter(name=name).first() ## 进行数据库校验，first()取第一个，为对象
if obj: ## 判断是否有对象，如果有：证明用户名已存在，如果没有：证明用户不存在，可以使用
return HttpResponse('用户名已存在') ## 返回给前端的ajax
else:
return HttpResponse('用户名可以使用') ## 返回给前端的ajax
# ajax登陆校验示例 - CBV版
使用ajax进行登陆校验，如果登录成功就跳转，如果不成功，就保持原先页面数据，并提醒错误
# 前端文件
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta http-equiv="content-Type" charset="UTF-8">
<meta http-equiv="x-ua-compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Title</title>
</head>
<body>
<p>
用户名：<input type="text" id="user">
</p>
<p>
密码：<input type="password" id="pwd">
</p>
<button id="b1">登录</button>
<script src="/static/jquery-3.4.1.min.js"></script>
<script>
$('#b1').click(function () {
$.ajax({
url: '/login/', {# 交互的地址 #}
type: 'post', {# 交互的方式 #}
data: { {# 要传递的数据 #}
user: $('#user').val(),
pwd: $('#pwd').val()
},
success: function (res) { {# 回调函数，后台逻辑执行成功时调用，res=后台返回的内容 #}
if (res.status == 0) { {# 判断后端数据中的status值为0就代表校验成功，为1就代表失败 #}
location.href = res.url {# 校验成功，获取后端传递的url，进行跳转 #}
}
else {
alert(res.msg) {# 校验失败，获取后端传递的msg，将错误提醒用弹框显示给用户 #}
}
}
})
})
</script>
</body>
</html>
# 后端文件
from django.http import JsonResponse
from django.views import View
class Login(View):
def get(self, request): ## 接收来自get方式的请求
return render(request, 'login.html') ## 返回login页面
def post(self, request): ## 接收来自post方式的请求 == 接收ajax交互
ret = {'status':0,'msg':''} ## 定义一个字典，status：状态，msg：存储错误提醒
user = request.POST.get('user') ## 获取POST方式中的key为user的value数据
pwd = request.POST.get('pwd') ## 获取POST方式中的key为pwd的value数据
obj = models.User.objects.filter(name=user, pwd=pwd).first() ## 进行数据库校验，first()取第一个，为对象
if obj: ## 判断是否有对象，如果有：证明校验成功，如果没有：证明校验失败
ret['url'] = '/index/' ## 向定义好的字典添加新的值，key：url，value：校验成功要返回的网址
return JsonResponse(ret) ## 通过json方式自动序列化字典数据传递回前端，到前端后自动反序列化
else: ## 证明校验失败
ret['status']=1 ## 定义状态为1，1：失败，默认0：成功
ret['msg']='用户名或密码错误' ## 定义错误提醒信息
return JsonResponse(ret) ## 通过json方式自动序列化字典数据传递回前端，到前端后自动反序列化
# 补充一个SweetAlert插件示例
# 主要js代码
点击下载Bootstrap-sweetalert项目 (opens new window)。
$(".btn-danger").on("click", function () {
swal({
title: "你确定要删除吗？",
text: "删除可就找不回来了哦！",
type: "warning",
showCancelButton: true,
confirmButtonClass: "btn-danger",
confirmButtonText: "删除",
cancelButtonText: "取消",
closeOnConfirm: false
},
function () {
var deleteId = $(this).parent().parent().attr("data_id");
$.ajax({
url: "/delete_book/",
type: "post",
data: {"id": deleteId},
success: function (data) {
if (data.status === 1) {
swal("删除成功!", "你可以准备跑路了！", "success");
} else {
swal("删除失败", "你可以再尝试一下！", "error")
}
}
})
});
})